Connectivity Software User's Guide and Reference
ReadOptionalValue<TValue>(IEasyUAClient,UAReadArguments) Method



OpcLabs.EasyOpcUACore Assembly > OpcLabs.EasyOpc.UA.Extensions Namespace > IEasyUAClientExtension2 Class > ReadOptionalValue Method : ReadOptionalValue<TValue>(IEasyUAClient,UAReadArguments) Method
The type to convert the attribute value to.
The client object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

An arguments object that specifies what to read from the OPC-UA server.

The value of this parameter cannot be null (Nothing in Visual Basic).

Reads a value of an attribute and converts it to the specified type, returning value result, or null if the node does not exist.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.CanBeNullAttribute()>
Public Overloads Shared Function ReadOptionalValue(Of TValue)( _
   ByVal client As IEasyUAClient, _
   ByVal readArguments As UAReadArguments _
) As ValueResult(Of TValue)
'Usage
 
Dim client As IEasyUAClient
Dim readArguments As UAReadArguments
Dim value As ValueResult(Of TValue)
 
value = IEasyUAClientExtension2.ReadOptionalValue(Of TValue)(client, readArguments)
[Extension()]
[JetBrains.Annotations.CanBeNull()]
public static ValueResult<TValue> ReadOptionalValue<TValue>( 
   IEasyUAClient client,
   UAReadArguments readArguments
)
[Extension()]
[JetBrains.Annotations.CanBeNull()]
public:
static ValueResult<TValue^>^ ReadOptionalValuegeneric<typename TValue>
( 
   IEasyUAClient^ client,
   UAReadArguments^ readArguments
) 

Parameters

client
The client object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

readArguments
An arguments object that specifies what to read from the OPC-UA server.

The value of this parameter cannot be null (Nothing in Visual Basic).

Type Parameters

TValue
The type to convert the attribute value to.

Return Value

A OpcLabs.BaseLib.OperationModel.Generic.ValueResult<T> containing the attribute value converted to type TValue, or null if the node does not exist.

This method can return null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also